Onfleet node #2593

jamesliupenn · 2021-12-22T21:50:26Z

Preparation

Set up your editor for code formatting (indentation, new lines, linting). If you use Visual Studio Code, you can use the TSLint extension for linting.
Get credentials (e.g., Client ID, Client Secret, API key, user login, user password, website URL) for the service you are building a node for.

Development

Open a pull request as early as possible with WIP in the pull request title. (We're doing this in one big PR 😆 )
If you are creating a node requested by a community member, make sure to comment on the feature request in the community forum (opens new window).
Ensure complementary operations to each resource (e.g., create, delete) have been added.
Ensure the node works with multiple items via one input.
Ensure the parameters have the correct type.
Mind the defaults: if the service has a default as true, keep it as true. Changing default values can break the existing workflows of the users.
Check if the node disposes of everything properly, in particular, if connections were properly closed.
Check your code using Nodelinter to ensure a clean lint before submitting your pull request

Testing

Test create and update operations with all fields/operations.
Test the continueOnFail option with a Function node. (For example, a Widget node has a GET operation that takes a widgetId and returns information on the widget. To test that the workflow continues on fail, set the Widget node to continue on fail, create a Function node, return a valid and an invalid widgetId, connect the Function node to Widget node, and run the workflow. The Widget node should show two items: one with information on the widget and another one with the error from having passed an invalid ID.)

Code formatting

Ensure the branch lints cleanly by running npm run lint.
Ensure the indentation is correct. Check this in the editorconfig.
Ensure there are no extra spaces. Check this in the editorconfig.
Code comment dividers inside if-branches.
Use "create/delete" verbs for operations, except for tags, where you should use "add/remove". (We still opt to use create in several cases to be uniform with our API documentation)

Errors and Outputs

Ensure empty API responses return { success: true }.
Ensure the error responses are handled and displayed correctly (e.g., malformed requests, requests with invalid credentials) and use the current format. You can check this by making failing requests to the API.
Check if the response can be simplified and add a simplify function (e.g., SecurityScorecard node). (Not needed in our case)
Ensure the response from Create is consistent with Get.
Ensure the response from Get All is consistent with Get.

Presentation

Ensure the primary menu contains only required parameters.
Ensure a JSON object is not shown in a single column in Table view. (Nested JSON)
Make sure all GetAll operations have the fields return and limit.
Ensure the property subtitle is set.
Make sure the pagination (if any) is working correctly. Set Limit 1.

Writing

Ensure all descriptions are correct and end with a period.
Ensure that most descriptions exist, excluding redundant ones.
Ensure IDs in displayNames are capitalized (i.e.: "IDs", not "ids" or "Ids").
Ensure that IDs, if multiple, have descriptive qualifiers.
Ensure the name property in description in the node class is written in camelCase.
Ensure the file name and the Class name are identical.

Branding

Ensure the name of the service is written correctly (e.g., "GitHub" not "Github"). If the node is a trigger node, ensure it is named as such, by adding "Trigger" after the service name (e.g., "Trello Trigger").
Ensure the logo is either a PNG or SVG, ideally the latter. Vecta is a good website to find SVGs of different applications.
If the logo is an SVG, ensure the canvas is a perfect square. If the logo is PNG, ensure it is 60x60 pixels and compressed.
Ensure the border color of the node matches the branding of the service.

Nice-to-haves (optional)

Add handler for continueOnFail. This feature is included in some of the newest nodes (e.g Lemlist node) to continue the workflow even if the node's execution fails.
Remove required: false and description: '' in the node descriptions (e.g., Lemlist node).
At call site, specify first body and then qs.
At call site, prepend the endpoint with slash / (e.g., "/campaign").

Added Onfleet nodes for working with different endpoints like: organizations, administrators, workers, hubs, teams, destinations, recipients, containers and webhooks.

INT-441: Add Onfleet nodes to n8n

feat: added name field to onfleet trigger node

CLAassistant · 2021-12-22T21:50:31Z

All committers have signed the CLA.

jamesliupenn · 2022-01-13T23:53:09Z

@ivov hi there, do you know what's the typical lead time to get a new node added? We're anticipating this release and hope to get an estimate of when this will be live.

janober · 2022-01-14T08:12:19Z

Thanks a lot for the contribution @jamesliupenn. The node is one of the next ones that will get reviewed. So should not be much longer.

jamesliupenn · 2022-01-14T08:18:16Z

Thanks! I realized we missed a few operations so we'll be making some updates tomorrow

RicardoE105

Got reviewed. Let me know if you have questions about any comments. @jamesliupenn

RicardoE105 · 2022-01-14T14:40:45Z

packages/nodes-base/nodes/Onfleet/GenericFunctions.ts

+	body: any = {}, // tslint:disable-line:no-any
+	qs?: any, // tslint:disable-line:no-any
+	uri?: string,
+	headers: IDataObject = {},


Header is a parameter but it's never used in the function?

RicardoE105 · 2022-01-14T14:41:41Z

packages/nodes-base/nodes/Onfleet/GenericFunctions.ts

+		const apiError = error as IDataObject;
+		const { message: messageError } = apiError.error as IDataObject;
+		if (messageError) {
+			const { message = '', cause = '' } = messageError as IDataObject;


Why don't you simply pass the error object to the NodeApiError?

RicardoE105 · 2022-01-14T14:43:01Z

packages/nodes-base/nodes/Onfleet/Onfleet.node.ts

+							value: 'admins',
+						},
+						{
+							name: 'Containers',


Resources names and values need to be singular.

RicardoE105 · 2022-01-14T14:44:19Z

packages/nodes-base/nodes/Onfleet/Onfleet.node.ts

+							value: 'webhooks',
+						},
+						{
+							name: 'Hubs',


Resources need to be ordered alphabetically

RicardoE105 · 2022-01-14T14:49:04Z

packages/nodes-base/nodes/Onfleet/OnfleetTrigger.node.ts

+	description: INodeTypeDescription = {
+		displayName: 'Onfleet Trigger',
+		name: 'onfleetTrigger',
+		icon: 'file:Onfleet.png',


Why are two different images? Onfleet and Onfleet@2x? Can you please optimize the png using https://tinypng.com/.

Or preferably use an SVG logo instead.

RicardoE105 · 2022-01-14T19:07:28Z